第1章 Pythonはどのような言語か
1.3 Pythonコミュニティの特徴
PEP 257:Docstring Conventions ── ドキュメントの書き方
PEP 257 – Docstring Conventions
ただし、PEP257は文法を規定しているものではありません。たとえば、「引数や戻り値の型情報をどう書くか」などは、プロジェクトを始める際にチームで決めましょう。(Kindle の位置No.751-752)
よく使われる記法
reStructuredText(👉
詳細情報フィールドのリスト(SphinxのDomains)
)
numpydoc(👉
Docstring Standard (numpydoc)
)
Google Python Style Guide(👉
3.8 Comments and Docstrings (Google Python Style Guide)
)